Description

Deprecates Logger in favor of its new base class RealmLogger (see notes below on avoiding breaking changes).

Primarily, enables more control over which category of messages should be logged and at which criticality level, by setting and getting a LogLevel for a given LogCategory. The hierarchy of categories starts at LogCategory.Realm.

RealmLogger.SetLogLevel(LogLevel.Warn, LogCategory.Realm.Sync);
RealmLogger.GetLogLevel(LogCategory.Realm.Sync.Client.Session); // LogLevel.Warn

Adds a function logger that accepts a callback that will receive the LogLevel, LogCategory, and the message when invoked.

RealmLogger.Default = RealmLogger.Function((level, category, message) => /* custom implementation */);

Adds a RealmLogger.Log() overload taking a category.

RealmLogger.Default.Log(LogLevel.Warn, LogCategory.Realm, "A warning message");

Notes on avoiding breaking changes

Would-be breaking changes

Users have been able to provide their own Logger subclass via the Logger.Default set accessor. Custom loggers need to override and implement Logger.LogImpl(), and with the addition of log categories in this PR, the LogImpl() signature would require breaking changes.

Solution

Essentially, the previous Logger class has been renamed RealmLogger, and another class called Logger now derives from RealmLogger, with the only own member being the LogImpl() with an abstract method identical to before to avoid the breaking change.

public abstract class Logger : RealmLogger
{
    protected abstract void LogImpl(LogLevel level, string message);

    protected override void LogImpl(LogLevel level, LogCategory category, string message)
    {
        LogImpl(level, message);
    }
}

Fixes #3633

@realm/devdocs

TODO

• Changelog entry
• Tests
• API docs